<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>PIWavelet: projects.piwavelet.piwavelet.piwavelet Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">PIWavelet
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="namespaces.html"><span>Packages</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li><a href="namespacemembers.html"><span>Package&#160;Functions</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceprojects.html">projects</a></li><li class="navelem"><a class="el" href="namespaceprojects_1_1piwavelet.html">piwavelet</a></li><li class="navelem"><a class="el" href="namespaceprojects_1_1piwavelet_1_1piwavelet.html">piwavelet</a></li><li class="navelem"><a class="el" href="namespaceprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet.html">piwavelet</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">projects.piwavelet.piwavelet.piwavelet Namespace Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1Morlet.html">Morlet</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements the <a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1Morlet.html" title="Implements the Morlet wavelet class.">Morlet</a> wavelet class.  <a href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1Morlet.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1Paul.html">Paul</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements the <a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1Paul.html" title="Implements the Paul wavelet class.">Paul</a> wavelet class.  <a href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1Paul.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1DOG.html">DOG</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements the derivative of a Guassian wavelet class.  <a href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1DOG.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1Mexican__hat.html">Mexican_hat</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements the Mexican hat wavelet class.  <a href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1Mexican__hat.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcoherence.html">wcoherence</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This class is an Python interface for the Wavelet Coherence matlab functions of the package for wavelet, cross-wavelet and coherence-wavelet analises profided by Aslak Grinsted, John C.  <a href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcoherence.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcross.html">wcross</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This class is an Python interface for the Cross wavelet Spectrun matlab functions of the package for wavelet, cross-wavelet and coherence-wavelet analises profided by Aslak Grinsted, John C.  <a href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1wcross.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1smooth.html">smooth</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This class is an Python interface for the Smoothing matlab functions of the package for wavelet, cross-wavelet and coherence-wavelet analises profided by Aslak Grinsted, John C.  <a href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1smooth.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1waveletCC.html">waveletCC</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Continuous wavelet transform of the signal at specified scales.  <a href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1waveletCC.html#details">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5b23242069fa8c430a2b96bfa14faaa2"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet.html#a5b23242069fa8c430a2b96bfa14faaa2">ar1</a></td></tr>
<tr class="memdesc:a5b23242069fa8c430a2b96bfa14faaa2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allen and Smith autoregressive lag-1 autocorrelation alpha.  <a href="#a5b23242069fa8c430a2b96bfa14faaa2"></a><br/></td></tr>
<tr class="memitem:a64cbd2681659c7666f1a7086ea085406"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet.html#a64cbd2681659c7666f1a7086ea085406">ar1_spectrum</a></td></tr>
<tr class="memdesc:a64cbd2681659c7666f1a7086ea085406"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lag-1 autoregressive theoretical power spectrum.  <a href="#a64cbd2681659c7666f1a7086ea085406"></a><br/></td></tr>
<tr class="memitem:abe9c6ffc351e734eda9303af63de2c22"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet.html#abe9c6ffc351e734eda9303af63de2c22">cwt</a></td></tr>
<tr class="memdesc:abe9c6ffc351e734eda9303af63de2c22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Continuous wavelet transform of the signal at specified scales.  <a href="#abe9c6ffc351e734eda9303af63de2c22"></a><br/></td></tr>
<tr class="memitem:a2f562484c18165343361bc1340ed3e92"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet.html#a2f562484c18165343361bc1340ed3e92">significance</a></td></tr>
<tr class="memdesc:a2f562484c18165343361bc1340ed3e92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Significance testing for the onde dimensional wavelet transform.  <a href="#a2f562484c18165343361bc1340ed3e92"></a><br/></td></tr>
<tr class="memitem:a000735dcdf58977f8d5be20f17be3ec1"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet.html#a000735dcdf58977f8d5be20f17be3ec1">plotWavelet</a></td></tr>
<tr class="memdesc:a000735dcdf58977f8d5be20f17be3ec1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Plot Wavelet Transfor for one signal.  <a href="#a000735dcdf58977f8d5be20f17be3ec1"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a8eada1217ba6ba922610c9c2f92bdad2"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet.html#a8eada1217ba6ba922610c9c2f92bdad2">__name</a> = 'piwavelets'</td></tr>
<tr class="memitem:a2ace4a8ef59b44e5b6534a1052f28dca"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet.html#a2ace4a8ef59b44e5b6534a1052f28dca">__authors</a> = 'Eduardo dos Santos Pereira, Regla D. Somoza'</td></tr>
<tr class="memitem:a881c963906cb656a47bbddc1e420a69e"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet.html#a881c963906cb656a47bbddc1e420a69e">__data</a> = '13/03/2013'</td></tr>
<tr class="memitem:a5b8a45d724de88e32186db27be99817e"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet.html#a5b8a45d724de88e32186db27be99817e">__email</a> = 'pereira.somoza@gmail.com,duthit@gmail.com'</td></tr>
</table>
<h2>Function Documentation</h2>
<a class="anchor" id="a5b23242069fa8c430a2b96bfa14faaa2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def projects.piwavelet.piwavelet.piwavelet.ar1 </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>x</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Allen and Smith autoregressive lag-1 autocorrelation alpha. </p>
<p>In a AR(1) model </p>
<pre class="fragment">x(t) - &lt;x&gt; = \gamma(x(t-1) - &lt;x&gt;) + \alpha z(t) ,
</pre><p>where &lt;x&gt; is the process mean,  and  are process parameters and z(t) is a Gaussian unit-variance white noise.</p>
<p>PARAMETERS x (array like) : Univariate time series</p>
<p>RETURNS g (float) : Estimate of the lag-one autocorrelation. a (float) : Estimate of the noise variance [var(x) ~= a**2/(1-g**2)] mu2 (foat) : Estimated square on the mean of a finite segment of AR(1) noise, mormalized by the process variance.</p>
<p>REFERENCES [1] Allen, M. R. and Smith, L. A. (1996). Monte Carlo SSA: detecting irregular oscillations in the presence of colored noise. Journal of Climate, 9(12), 3373-3404. </p>

</div>
</div>
<a class="anchor" id="a64cbd2681659c7666f1a7086ea085406"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def projects.piwavelet.piwavelet.piwavelet.ar1_spectrum </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>freqs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>ar1</em> = <code>0.</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Lag-1 autoregressive theoretical power spectrum. </p>
<p>PARAMETERS ar1 (float) : Lag-1 autoregressive correlation coefficient. freqs (array like) : Frequencies at which to calculate the theoretical power spectrum.</p>
<p>RETURNS Pk (array like) : Theoretical discrete Fourier power spectrum of noise signal. </p>

</div>
</div>
<a class="anchor" id="abe9c6ffc351e734eda9303af63de2c22"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def projects.piwavelet.piwavelet.piwavelet.cwt </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>signal</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>dt</em> = <code>1.</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>dj</em> = <code>1./12</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>s0</em> = <code>-1</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>J</em> = <code>-1</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>wavelet</em> = <code>Morlet()</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>result</em> = <code>None</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Continuous wavelet transform of the signal at specified scales. </p>
<p>PARAMETERS signal (array like) : Input signal array dt (float) : Sample spacing. dj (float, optional) : Spacing between discrete scales. Default value is 0.25. Smaller values will result in better scale resolution, but slower calculation and plot. s0 (float, optional) : Smallest scale of the wavelet. Default value is 2*dt. J (float, optional) : Number of scales less one. Scales range from s0 up to s0 * 2**(J * dj), which gives a total of (J + 1) scales. Default is J = (log2(N*dt/so))/dj. wavelet (class, optional) : Mother wavelet class. Default is Morlet() result (string, optional) : If set to 'dictionary' returns the result arrays as itens of a dictionary.</p>
<p>RETURNS W (array like) : Wavelet transform according to the selected mother wavelet. Has (J+1) x N dimensions. sj (array like) : Vector of scale indices given by sj = s0 * 2**(j * dj), j={0, 1, ..., J}. freqs (array like) : Vector of Fourier frequencies (in 1 / time units) that corresponds to the wavelet scales. coi (array like) : Returns the cone of influence, which is a vector of N points containing the maximum Fourier period of useful information at that particular time. Periods greater than those are subject to edge effects. fft (array like) : Normalized fast Fourier transform of the input signal. fft_freqs (array like): Fourier frequencies (in 1/time units) for the calculated FFT spectrum.</p>
<p>EXAMPLE mother = wavelet.Morlet(6.) wave, scales, freqs, coi, fft, fftfreqs = wavelet.cwt(var, 0.25, 0.25, 0.5, 28, mother) </p>

</div>
</div>
<a class="anchor" id="a000735dcdf58977f8d5be20f17be3ec1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def projects.piwavelet.piwavelet.piwavelet.plotWavelet </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>signal</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>title</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>label</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>units</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>mother</em> = <code>Morlet(6.)</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>t0</em> = <code>1.0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>dt</em> = <code>1.0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>dj</em> = <code>0.25</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>s0</em> = <code>-1</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>J</em> = <code>-1</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>alpha</em> = <code>0.0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>slevel</em> = <code>0.95</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>avg1</em> = <code>15</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>avg2</em> = <code>20</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>nameSave</em> = <code>None</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Plot Wavelet Transfor for one signal. </p>
<p>PARAMETER: signal : The signal that will be transformed title : Title of the plot label : Label units : unit of the data mother : The Mother Wavelet. Default <a class="el" href="classprojects_1_1piwavelet_1_1piwavelet_1_1piwavelet_1_1Morlet.html" title="Implements the Morlet wavelet class.">Morlet</a> mother wavelet with wavenumber=6 t0 : Initial time step dt : time step dj : Four sub-octaves per octaves s0 : Starting scale, here 6 months J : Seven powers of two with dj sub-octaves alpha: Lag-1 autocorrelation for white noise slevel : Significance level avg1,avg2 : Range of periods to average nameSave : Path plus name to save the plot </p>

</div>
</div>
<a class="anchor" id="a2f562484c18165343361bc1340ed3e92"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def projects.piwavelet.piwavelet.piwavelet.significance </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>signal</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>dt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>scales</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>sigma_test</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>alpha</em> = <code>0.</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>significance_level</em> = <code>0.95</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>dof</em> = <code>-1</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>wavelet</em> = <code>Morlet()</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Significance testing for the onde dimensional wavelet transform. </p>
<p>PARAMETERS signal (array like or float) : Input signal array. If a float number is given, then the variance is assumed to have this value. If an array is given, then its variance is automatically computed. dt (float, optional) : Sample spacing. Default is 1.0. scales (array like) : Vector of scale indices given returned by cwt function. sigma_test (int, optional) : Sets the type of significance test to be performed. Accepted values are 0, 1 or 2. If omitted assume 0.</p>
<p>If set to 0, performs a regular chi-square test, according to Torrence and Compo (1998) equation 18.</p>
<p>If set to 1, performs a time-average test (equation 23). In this case, dof should be set to the number of local wavelet spectra that where averaged together. For the global wavelet spectra it would be dof=N, the number of points in the time-series.</p>
<p>If set to 2, performs a scale-average test (equations 25 to 28). In this case dof should be set to a two element vector [s1, s2], which gives the scale range that were averaged together. If, for example, the average between scales 2 and 8 was taken, then dof=[2, 8]. alpha (float, optional) : Lag-1 autocorrelation, used for the significance levels. Default is 0.0. significance_level (float, optional) : Significance level to use. Default is 0.95. dof (variant, optional) : Degrees of freedom for significance test to be set according to the type set in sigma_test. wavelet (class, optional) : Mother wavelet class. Default is Morlet().</p>
<p>RETURNS signif (array like) : Significance levels as a function of scale. fft_theor (array like): Theoretical red-noise spectrum as a function of period. </p>

</div>
</div>
<h2>Variable Documentation</h2>
<a class="anchor" id="a2ace4a8ef59b44e5b6534a1052f28dca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string projects.piwavelet.piwavelet.piwavelet.__authors = 'Eduardo dos Santos Pereira, Regla D. Somoza'</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a881c963906cb656a47bbddc1e420a69e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string projects.piwavelet.piwavelet.piwavelet.__data = '13/03/2013'</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a5b8a45d724de88e32186db27be99817e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string projects.piwavelet.piwavelet.piwavelet.__email = 'pereira.somoza@gmail.com,duthit@gmail.com'</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a8eada1217ba6ba922610c9c2f92bdad2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string projects.piwavelet.piwavelet.piwavelet.__name = 'piwavelets'</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 21 2013 12:58:16 for PIWavelet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
